home *** CD-ROM | disk | FTP | other *** search
/ System Booster / System Booster.iso / Commodities / OkayDokey / OkayDokey.autodoc < prev    next >
Encoding:
Text File  |  1996-09-27  |  5.8 KB  |  155 lines
  1. OkayDokey/Documentation                               OkayDokey/Documentation
  2.  
  3.    PROGRAM
  4.      OkayDokey
  5.      Version 1.4
  6.      Relase date: 19.6.95
  7.  
  8.    COPYRIGHT
  9.      © 1995 Paul Huxham
  10.      Bonusware, all rights reserved.
  11.  
  12.    DISTRIBUTION
  13.      OkayDokey should be distributed at no charge to the end user. It may
  14.      be included on CDROMs with no restrictions.
  15.  
  16.    PURPOSE
  17.      Attempts to close the specified window requester by inducing key events
  18.      into the input stream (specifically for retry and cancel requesters).
  19.  
  20.    CONTENTS
  21.      OkayDokey = This is the program.
  22.      OkayDokey.info = The program icon.
  23.      OkayDokey.autodoc = Documention you are reading now.
  24.  
  25.    USAGE
  26.      OkayDokey can be called from the shell or Workbench.
  27.  
  28.      From the shell, OkayDokey supports the following arguments:
  29.  
  30.      PUBSCREEN=SC,WINDOW=WI,TIMER=TI/N,CANCEL=CAN/S,ACTIVATE=ACT/S,
  31.      COMMODITY=CX,QUIET/S, QUITAFTER=QA/S
  32.  
  33.      PUBSCREEN is the public screen on which to look for a specific window
  34.       requester. Case sensitive. Defaults to the default public screen
  35.       (usually Workbench). It is also the screen the OkayDokey window will
  36.       open on (unless you are using the CX argument). This argument is
  37.       required for closing a window.
  38.  
  39.      WINDOW is the title of the window requester to search for. Case
  40.       sensitive. There is no default. This argument is required for
  41.       closing a window.
  42.  
  43.      TIMER is how many ¼ seconds to wait between window requester searches.
  44.       4 = 1 second. The default is 2 (½ a second). Making this value too
  45.       low could degrade the performance of Intuition on some machines.
  46.  
  47.      CANCEL if specified, selects the Cancel gadget of a requester (sends the
  48.       sequence Left Amiga B). When not specified selects the Retry/Ok gadget
  49.       (sends the sequence Left Amiga V).
  50.  
  51.      ACTIVATE Normally if the specified window is found but not active,
  52.       nothing will happen. Specifiying ACTIVATE will force the window to
  53.       become active and then send the appropriate sequence. This can take up
  54.       to 2 TIMER cycles. If there is more than one window open with the same
  55.       title by using this parameter you can close multiple windows on the
  56.       same screen with the same title.
  57.  
  58.      COMMODITY This launches OkayDokey as a commodity with the name
  59.       specified. If you are starting a new OkayDokey, no window will be
  60.       opened. Exchange can be used to control the activation and removal of
  61.       this OkayDokey. You may launch more than one OkayDokey as a commodity
  62.       by using different names for them. In Exchanges' requester you can see
  63.       what window title is being searched for. Supplying only this parameter
  64.       when running OkayDokey will remove an OkayDokey with that name (see
  65.       notes).
  66.  
  67.      QUIET If any errors occur, OkayDokey will not print or display any
  68.       requesters complaining that something went wrong. Default is it be
  69.       noisy.
  70.  
  71.      QUITAFTER will quit OkayDokey after it sends a command sequence to the
  72.       first window that matches the search arguments. Default is not to quit.
  73.  
  74.      From the Workbench, OkayDokey supports the following tooltypes:
  75.  
  76.      PUBSCREEN, WINDOW, TIMER, ACTIVATE, CANCEL, COMMODITY, QUIET
  77.      and QUITAFTER
  78.  
  79.       These function the same as their shell equivalents.
  80.  
  81.    REQUIREMENTS
  82.      A minimum of Kickstart 2.x is required.
  83.  
  84.    NOTES
  85.      When OkayDokey is launched with the COMMODITY parameter to remove an
  86.      OkayDokey, it can interfere with a commodity if the name specified is
  87.      NOT an OkayDokey. This would have the same effect as running the
  88.      original application again (some programs quit, others pop up their
  89.      interface).
  90.  
  91.      Spaces in names need to be surrounded with double quote marks.
  92.  
  93.      Some window names have trailing spaces. These NEED to be included.
  94.  
  95.      The title bar of the OkayDokey window will have the name of the window
  96.      requester being searched for unless you are running as a commodity in
  97.      which case it appears in Exchange.
  98.  
  99.      To quit OkayDokey:
  100.       1) Click the close gadget of the OkayDokey window.
  101.       2) If a commodity, run OkayDokey again with the same parameters.
  102.       3) If a commodity, use Exchange or a commodity command program.
  103.       4) Send the OkayDokey task a break signal.
  104.  
  105.      To close more than one window or requester, run multiple copies of
  106.      OkayDokey.
  107.  
  108.    EXAMPLE
  109.      To automatically press the Ok gadget of the KickStart 3.0 WorkBench
  110.      About requester:
  111.  
  112.      OkayDokey SC=Workbench WI="3.00 ROM " ACTIVATE
  113.  
  114.      Every ½ second, OkayDokey will search for the requester window titled
  115.      "3.00 ROM " on the Workbench screen and attempt to press the Ok gadget.
  116.  
  117.    HISTORY
  118.      V1.0 Not released.
  119.      V1.2 Initial public release.
  120.      V1.3 Not released.
  121.            * Fixed a bug where if multiple windows of the same name were open
  122.              and ACTIVATE was used, the windows might not have been closed.
  123.      V1.4 Major internal rewrite using my new code skeleton.
  124.            * Added commodity support - the window no longer needs to be open.
  125.            * Improved documentation.
  126.  
  127.    COMPLIER
  128.      OkayDokey was written using CED V3.5 and compiled with SAS/C 6.55 on
  129.      an Amiga 4000/040. Enforcer was used to detect and correct programming
  130.      errors.
  131.  
  132.    BUGS
  133.      None known at present.
  134.  
  135.    TODO
  136.      1) To be able to send a user definable command to the window, instead of
  137.         just a retry or cancel sequence.
  138.      2) Title string supplied can be a substring of the windows titlebar.
  139.      3) Locale support.
  140.  
  141.    THANKYOU
  142.      Steve Quartly for help with the inducing of events into input.device.
  143.      The users of OkayDokey for providing ideas for improvement.
  144.  
  145.    AUTHOR
  146.      You can contact the author via:
  147.       Email:
  148.        paulh@Perth.DIALix.oz.au
  149.      or
  150.        P.O. Box 875
  151.        Morley,
  152.        Perth,
  153.        Western Australia 6943
  154.  
  155.